Replace HTML definition lists with Markdown syntax#62
Merged
Conversation
SmartyPants (remark-smartypants) converts `--` to `—` (em dash) inside
`<code>` tags within the `<dl>` HTML block on the environment variables
page. Use JSX expressions (`{'--flag'}`) to bypass the transformation
and render flags like `--project`, `--repo`, `--client-id`, and
`--client-secret` correctly.
https://claude.ai/code/session_0163JhpTd1Sojez8yK7ARqnW
Replace the raw HTML `<dl>` block in environment-variables.mdx with Markdown definition list syntax (`: ` prefix). Add remark-definition-list plugin so Astro/Starlight renders them as `<dl>`/`<dt>`/`<dd>`. This fixes `--project`, `--repo`, `--client-id`, `--client-secret`, and `bee auth login --method oauth` being rendered with an em-dash (`—`) instead of double dashes due to SmartyPants typography conversion inside raw HTML blocks. https://claude.ai/code/session_0163JhpTd1Sojez8yK7ARqnW
Convert all remaining <dl>/<dt>/<dd> HTML blocks in docs to Markdown definition list syntax using the remark-definition-list plugin added in the previous commit. Files updated: - integrations/ai-agent.mdx - guides/authentication.mdx (inside <Card> components) - recipes/release-notify-issues.mdx - recipes/pr-lifecycle-sync.mdx https://claude.ai/code/session_0163JhpTd1Sojez8yK7ARqnW
Coverage Report
File CoverageNo changed files found. |
Add guidance to the Documentation site section about using Markdown definition list syntax (term + `: description`) instead of raw <dl>/<dt>/<dd> HTML, including a note that it works inside JSX components like <Card>. https://claude.ai/code/session_0163JhpTd1Sojez8yK7ARqnW
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Converts all HTML
<dl>definition list markup to Markdown definition list syntax across documentation files. This change improves maintainability and consistency by using semantic Markdown instead of raw HTML.The conversion includes:
<dl>,<dt>, and<dd>tags with Markdown definition list syntax (term followed by: definition)<code>tags to backticks for consistencyremark-definition-listplugin to Astro config to properly parse and render the new Markdown syntaxFiles updated:
environment-variables.mdx: 6 environment variable definitionspr-lifecycle-sync.mdx: 5 customization optionsauthentication.mdx: 4 authentication method comparisonsrelease-notify-issues.mdx: 3 customization optionsai-agent.mdx: 2 documentation endpoint referencesTest plan
Verify that definition lists render correctly in the documentation by checking that:
https://claude.ai/code/session_0163JhpTd1Sojez8yK7ARqnW